Devices > Remote Devices > BSAP EIE > Data Groups

Data Groups

With few exceptions, data groups must be defined in a device template file in order for them to be available for use on a remote device. Which data groups are defined by a device template file depends on protocol, device type, and unique configuration.

CygNet distributes sample device template files for its EIEs, each of which typically serves one or more hardware models along with applicable firmware. Therefore, the data groups described below are only those data groups defined by CygNet in sample device template file(s). Your template(s) might not include some of the data groups described below. Device template files exist to enable users to customize device configurations; however, CygNet is not responsible for changes made by users.

For information about data group definitions and device template files, see Device Template Files.

For more information about data group dependencies, see Data Group Dependencies.

For more information, see the following subsections:

Data Group Types Defined by the "dgStruct" Attribute

The BSAP EIE manages most data groups according to type as defined by the data group’s dgStruct attribute.

<DataGroupType niceName="Data Group Name" dgStruct="type" ... >

Available types and attribute values are listed in the table below.

Note: The attributes values are case sensitive.

Data Group Type Attribute Value Usage Notes

Analog Array/Dated Analog Array

AArray/DAArray

Analog Array and Dated Analog Array data groups handle sets of analog data group elements (floating points) and are identified by dgStruct="AArray" or dgStruct="DAArray". A Dated Analog Array("DAArray") data group displays the date in the first column.

Array numbers are configured in the same manner as list data groups. Both the single specification and the ordinal format are supported.

See Configuring Array-Related Data Groups.

Archive

Archive

Archive data groups are used for historical data, but otherwise have the same format as signal data groups. Only the value (Val column) for a signal is stored in dated rows. Archive data groups are identified by dgStruct="Archive".

Array History

ArrayHistory

The Array History data group retrieves data that is historical in nature from the Analog array on a BSAP device. This data group is identified by dgStruct="ArrayHistory". The data group element supports the following attributes:

Attribute Description

currentIndex

currentIndex identifies the record index in the array that has the last written record.

Value:
  • Integer value only.

dgDateDeid

dgDateDeid identifies which column/deid will have the date in it.

Value:
  • Any applicable string, for example, DateTime.

dgStruct

dgStruct determines the data group type for the BSAP EIE.

Value:
  • AArray
  • Archive
  • ArrayHistory
  • Audit
  • DAArray
  • LArray
  • List
  • Search
  • Signal

dgStructNum_ord<Ord>

dgStructNum_ord<Ord> identifies the array number as it corresponds to the ordinal of the data group, where 1 could be any number, i.e., dgStructNum_ord (2,3,4).

Value:
  • Integer value only.

See List below for a definition for dgStructNum_ord<Ord>.

isOldToNew

isOldToNew specifies the order (oldest to newest or newest to oldest) by which historical array values are retrieved. For example, when isOldToNew is false, the data is in descending order, and the newest record is at the top of the array. The order affects PNT point processing. isOldToNew must be used in conjunction with an array that is defined by using the hasHistory attribute set to true.

Value:
  • Must be a Boolean value true or false.

queueStart

queueStart is the first index in the queue and identifies the point in the array where valid data begins. This is useful if there are blank records at the beginning of the array.

Value
  • Integer value only.
  • Default is 1.

recordMinutes

recordMinutes identifies the number of minutes represented in a history record. To get FMS history, you must include both the histType and recordMinutes attributes along with their respective values.

Value
  • Integer value.
  • If you want to indicate that history record periodization is irregular (that is, each period may vary in length from the last), enter the value N/A instead of an integer.

The following request types are supported:

  1. Get Latest
  2. Index Based Request
  3. Date Based Request

See the following example data group for retrieving daily history data:

<HistDlyAry niceName="Daily History Array" dgStruct="ArrayHistory" canSend="false" maxCnt="1" baseOrd="1" devDG="false" dgDateDeid="DateTime" ordLabel="Run#" dgStructNum_ord1="41" recordMinutes="1440" isOldToNew="false" queueStart="2" currentIndex="2">

Audit

Audit

Audit data groups are used for historical event and alarm records, and otherwise have the same format as signal data groups. Audit data groups are identified by dgStruct="Audit".

Set oldNew="true" if text from device represents Old/New values for digitals. Set oldNew="false" if it represents the value of True/False conditions.

Data groups of this type can be configured to optimize audit log retrieval by setting the Optimization setting on the Data Group Properties dialog box. Options include None: read entire log (default) and Get latest: read and purge. See Optimization for more information.

Note: If you change the setting to read and purge the audit log you will be prompted to change the transaction retention settings to retain more data or accept transaction retention settings, which may cause CygNet to lose data that can’t be retrieved again.

List

List

A list data group is used to process a predefined list of signals.

Lists can be configured with the ACCOL load file on the device. Because they are defined at the device level, messaging using lists can be more efficient than using signal data groups.

List data groups are identified by dgStruct="List", and require either a dgStructNum or one or more dgStructNum_ord<Ord> attributes to be present.

The dgStructNum attribute corresponds to an RTU list number defined in the load file. The dgStructNum_ord<Ord> attribute, where <Ord> is replaced with the ordinal number, indicates that the list is dependent on the ordinal number of the data group.

See Configuring Signal-Related Data Groups.

In the following example, the data group uses list 10 for ordinal 1 and list 11 for ordinal 2:

<DataGroup dgStruct="List" dgStructNum_ord1="10" dgStructNum_ord2="11" ... >

Logical Array

LArray

Logical Array data groups handle sets of logical data group elements (bits) and are identified by dgStruct="LArray".

Array numbers are configured in the same manner as list data groups. Both the single specification and the ordinal format are supported.

See Configuring Array-Related Data Groups.

RTUConfig

Signal

A valid "RTU Config" data group must be retrieved before other data groups can be retrieved or sent. The "RTU Config" data group is identified by dgStruct="Signal".

Search

Search

A search data group enables signal retrieval based on filter criteria. This type is available only for EGM 3530 and Teleflow models. Search data groups are identified by dgStruct="Search".

See Configuring Search Data Groups.

Signal

Signal

A signal represents a data group element along with its fields (listed in columns). A signal data group is a list of signals from the device. These signals do not need to be in any specific order or from any specific location. Signal data groups are identified by dgStruct="Signal".

See Configuring Signal-Related Data Groups.
Back to top

FMS Data Group Types

The FMS data groups do not retrieve data directly from a remote device; instead, they depend on another data group to supply data to them. These data groups are not defined by the dgStruct attribute.

Note: In the supportDg list in the device template file for FMS data groups, if you want to include a data group that is not included on the FMS ordinal, that data group must be on ordinal 0.

Data Group Type Usage Notes

FmsAlarm

"FMS Alarm Data" depends on a support data group identified by attribute type dgStruct="Audit" to supply data to it. Support data groups are assigned to an "FMS Alarm Data" data group in the supportDg element of the "FMS Alarm Data" data group in a device template file.

Dependencies:
  • Audit

"Audit Trail" (Audit) must be instantiated before this data group can be polled.

See FMS Alarm Data Group.

FmsConfig

"FMS Configuration Data" depends on a support data group to supply data to it. Support data groups are assigned to an "FMS Configuration" data group in the supportDg element of the "FMS Configuration" data group in a device template file.

"FMS Configuration" must be retrieved before polling other FMS data groups of the same ordinal.

See FMS Configuration Data Group.

FmsEvent

"FMS Event Data" depends on a support data group identified by attribute type dgStruct="Audit" to supply data to it. Support data groups are assigned to an "FMS Event Data" data group in the supportDg element of the "FMS Event Data" data group in a device template file.

Dependencies:
  • Audit

"Audit Trail" (Audit) must be instantiated before this data group can be polled.

See FMS Event Data Group.

FmsHist

"FMS History" depends on a support data group identified by attribute type dgStruct="Archive" or dgStruct="Array History" for its data. Support data groups are assigned to an "FMS History" data group in the supportDg element of the "FMS History" data group in a device template file.

Dependencies:
  • Archive

    • -OR-

  • ArrayHistory

Note: The selected support data group must be instantiated before the "FMS History" data group can be polled.

See FMS History Data Groups.

FMS Legacy Data Group Types

The FMS Legacy data groups do not retrieve data directly from a remote device; instead, they depend on another data group to supply data to them. These data groups are not defined by the dgStruct attribute.

Note: Device template validation for BSAP FMS Legacy data groups has changed. If you are not migrating to the new BSAP FMS data groups, be sure to perform the CygNet Upgrade Procedure for device templates.

Data Group Type Usage Notes

GmrCfgSend

"FMS Legacy Config Send Data" is used to send modified measurement data to the field device.

This data group is required only if you plan to use FMS and want to perform this specific task.

GmrConfig

"FMS Legacy Configuration Data" depends on a support data group to supply data to it. Support data groups are assigned to an "FMS Legacy Configuration" data group in the gmrDataGroupList element of the "FMS Legacy Configuration" data group in a device template file.

See FMS Legacy Configuration Data Group.

GmrEvent

"FMS Legacy Events Data" depends on the "Audit" data group to supply data to it. Support data groups are assigned to an "FMS Legacy Events" data group in the gmrDataGroupList element of the "FMS Legacy Events" data group in a device template file.

See FMS Legacy Events Data Group.

Dependencies:
  • "Audit"

GmrHist

"FMS Legacy History Data" depends on a support data group to supply data to it. Support data groups are assigned to an "FMS Legacy History" data group in the gmrDataGroupList element of the "FMS Legacy History" data group in a device template file.

See FMS Legacy History Data Group.
Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.